.\" manual page [] for Burp
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
.TH Burp 8 "Burp"
.SH NAME
Burp \- BackUp and Restore Program
.SH SYNOPSIS
.B burp [OPTIONS]
.SH DESCRIPTION
.LP
BackUp and Restore Program.

.SH SERVER OPTIONS
.TP
\fB\-a c\fR \fB\fR
Run as a stand-alone champion chooser process (useful for debugging protocol2 style backups).
.TP
\fB\-c\fR \fB[path]\fR
Short for 'config file'. The argument is a path to the config file. The default
is /etc/burp/burp.conf.
.TP
\fB\-F\fR \fB\fR
Foreground mode. The server will fork into the background and run as a daemon if you do not give this option.
.TP
\fB\-g\fR \fB\fR
Generate initial CA keys and certificates, and then exit.
.TP
\fB\-h\fR \fB\fR
Print help and then exit.
.TP
\fB\-?\fR \fB\fR
Print help and then exit.
.TP
\fB\-i\fR \fB\fR
Print an index table of symbols that humans may see burp produce, and exit.
.TP
\fB\-n\fR \fB\fR
No forking mode. The program will accept a single query, deal with it, and then
exit. This is useful for debugging. Implies '\-F'. If you intend to debug a protocol2 session, you will also want to run a separate champion chooser process ('\-a c' below).
.TP
\fB\-Q\fR \fB\fR
Do not log to stdout (overrides config file 'stdout' setting).
.TP
\fB\-t\fR \fB\fR
Dry-run mode to test config file syntax.
.TP
\fB\-v\fR \fB\fR
Print version and exit.
.TP
ADDITIONAL SERVER OPTIONS TO USE WITH '\-a c'
.TP
\fB\-C\fR \fB[client]\fR
Run as if forked via a connection from this client.

.SH CLIENT OPTIONS
.TP
\fB\-a\fR \fB[b|t|r|l|L|v|delete|e|T|d|D]\fR
Short for 'action'. The arguments mean backup, timed backup, restore, list, long list, verify, delete, estimate, timer check, diff, or long diff, respectively.
.TP
\fB\-b\fR \fB[number|a]\fR
Short for 'backup number'. The argument is a number, or 'a' to select all
backups.
.TP
\fB\-c\fR \fB[path]\fR
Short for 'config file'. The argument is a path to the config file. The default
is /etc/burp/burp.conf, or %PROGRAMFILES%\\Burp\\burp.conf on Windows.
.TP
\fB\-C\fR \fB[client]\fR
Allows you to specify an alternative client to list or restore from. Requires that the server configuration of the alternative client permits your client to do this. See the 'restore_client' option.
.TP
\fB\-d\fR \fB[path]\fR
Short for 'directory'. When restoring, the argument is a path to an alternative directory to restore to. When listing, the argument is the directory to list.
.TP
\fB\-f\fR
Short for 'force overwrite'. Without this option set, a restore will not
overwrite existing files.
.TP
\fB\-h\fR \fB\fR
Print help and then exit.
.TP
\fB\-?\fR \fB\fR
Print help and then exit.
.TP
\fB\-i\fR \fB\fR
Print an index table of symbols that humans may see burp produce, and exit.
.TP
\fB\-q\fR \fB[max secs]\fR
When running a timed backup, sleep for a random number of seconds (between 0 and the number given) before contacting the server. Alternatively, this can be specified by the 'randomise' configuration file option.
.TP
\fB\-Q\fR \fB\fR
Do not log to stdout (overrides config file 'stdout' setting).
.TP
\fB\-r\fR \fB[regex]\fR
Short for 'regular expression'. The argument is a regular expression with
which to match backup files. Use it for lists and restores.
.TP
\fB\-s\fR \fB[number]\fR
For use with restores \- strip a number of leading path components.
.TP
\fB\-t\fR \fB\fR
Dry-run mode to test config file syntax.
.TP
\fB\-x\fR
For Windows clients only - do not use the Windows VSS API on restore. Give this option when you are restoring a backup that contains no VSS information.
.TP
\fB\-a s\fR \fB\fR
Run this to connect to a running server to get a live monitor of the status of all your backup clients. The live monitor requires ncurses support at compile time.
.TP
\fB\-a S\fR \fB\fR
Similar to '\-a s', but it prints the main status monitor summary screen to stdout. One application is that a script can run this and email an administrator the output on a cron job. This doesn't require ncurses support. There are additional options that can be given with both these options, listed below.

.TP
ADDITIONAL CLIENT OPTIONS TO USE WITH '\-a s' and '\-a S'
.TP
\fB\-C\fR \fB[client]\fR
Limit the output to a single client.
.TP
\fB\-b\fR \fB[number]\fR
Show listable files in a particular backup (requires \-C).
.TP
\fB\-z\fR \fB[file]\fR
Dump a particular log file in a backup (requires \-C and \-b).
.TP
\fB\-d\fR \fB[path]\fR
Show a particular path in a backup (requires \-C and \-b).
.TP
\fB\-l\fR \fB[path]\fR
Log file for status monitor - useful for debugging.

.SH EXAMPLES
.TP
\fBburp \-a b\fR
Runs a backup.
.TP
\fBburp \-a l\fR
Lists the available backups and dates.
.TP
\fBburp \-a l \-b 1\fR
Lists all the files in backup number 1.
.TP
\fBburp \-a l \-b a\fR
Lists all the files in all the backups.
.TP
\fBburp \-a l \-b c\fR
Lists all the files in the current backup.
.TP
\fBburp \-a l \-b 1 \-r myregex\fR
Lists all the files in backup number 1 that match the regular expression 'myregex'.
.TP
\fBburp \-a L \-b 1 \-r myregex\fR
Long lists all the files in backup number 1 that match the regular expression 'myregex'. This is like doing an 'ls \-l'.
.TP
\fBburp \-a r \-b 1 \-r myregex\fR
Restores all the files in backup number 1 that match the regular expression 'myregex' back to their original location.
.TP
\fBburp \-a r \-b 1 \-r myregex \-d /tmp/restoredir\fR
Restores all the files in backup number 1 that match the regular expression 'myregex' into the directory /tmp/restoredir.
.TP
\fBburp \-a r \-b 1 \-r myregex \-d /tmp/restoredir \-s 2\fR
Restores all the files in backup number 1 that match the regular expression 'myregex' into the directory /tmp/restoredir and strip 2 leading path components.
.TP
\fBburp \-a r\fR
Restores all the files in the most recent backup to their original location.
.TP
\fBburp \-a v\fR
Verifies the most recent backup.
.TP
\fBburp \-a v \-b 1 \-r myregex\fR
Verifies everything in backup number 1 that matches the regular expression 'myregex'.
.TP
\fBburp \-a delete \-b 1\fR
Deletes backup number 1. Note that burp will not delete backup directories that other backup directories depend upon.
.TP
\fBburp \-a t\fR
Timed backup. The same as 'burp \-a b', except that a script is run on the server before deciding to go ahead. The intention is that this command will be run on a repeating cron job with a short interval, and that the server will decide when it is time for a new backup.
.TP
\fBburp \-a L \-b 1 \-d ''\fR
Long list the top level directory of backup 1.
.TP
\fBburp \-a L \-b 1 \-d '/home/graham'\fR
Long list the /home/graham directory of backup 1. These '\-d' versions of the list function provide the ability to 'browse' backups.
.TP
\fBburp \-a d\fR
Report the differences between the current backup and the backup that will be made next. DIFF OPTIONS NOT FULLY IMPLEMENTED YET.
.TP
\fBburp \-a D\fR
A more verbose report of the differences between the current backup and the backup that will be made next.
.TP
\fBburp \-a d \-b 1 \-b 2\fR
Report the differences between backups 1 and 2 (use \-a D for more verbosity).
.TP
\fBburp \-a d \-b 2 \-b n\fR
Report the differences between backup 1 and the backup that will be made next (use \-a D for more verbosity).
.TP
\fBburp \-C altclient \-a L\fR
Long list the top level directory of backup 1 on client 'altclient'.
.TP
\fBburp \-C altclient \-a r \-b 1 \-r myregex \-d /tmp/restoredir\fR
Restores all the files in backup number 1 from client 'altclient' that match the regular expression 'myregex' into the directory /tmp/restoredir.
.TP
\fBburp \-a s\fR
Run the ncurses status monitor.
.TP
\fBburp \-a S\fR
Print a status monitor snapshot, summarising all clients.
.TP
\fBburp \-a S \-C testclient\fR
Print a status monitor snapshot, showing client 'testclient' only.

.SH SERVER CONFIGURATION FILE OPTIONS

.TP
\fB. [glob]\fR
Read additional configuration files.
.TP
\fBmode=server\fR
Required to run in server mode.
.TP
\fBaddress=[address]\fR
Defines the main TCP address that the server listens on. The default is either '::' or '0.0.0.0', dependent upon compile time options.
.TP
\fBport=[port number]\fR
Defines the main TCP port that the server listens on.
.TP
\fBstatus_address=[address]\fR
Defines the main TCP address that the server listens on for status requests. The default is either '::1' or '127.0.0.1', dependent upon compile time options.
.TP
\fBstatus_port=[port number]\fR
Defines the TCP port that the server listens on for status requests. Comment this out to have no status server.
.TP
\fBcname_lowercase=[0|1]\fR
Whether to force lowercase cname when looking-up in clientconfdir. This also affects the fqdn lookup on the client (see client configuration options for details). The default is 0. When set to 1 the name provided by the client while authenticating will be lowercased.
.TP
\fBcname_fqdn=[0|1]\fR
Whether to keep fqdn cname (like 'testclient.example.com') when looking-up in clientconfdir. This also affects the fqdn lookup on the client (see client configuration options for details). The default is 1. When set to 0, the fqdn provided by the client while authenticating will be stripped ('testclient.example.com' becomes 'testclient').
.TP
\fBdaemon=[0|1]\fR
Whether to daemonise. The default is 1.
.TP
\fBfork=[0|1]\fR
Whether to fork children. The default is 1.
.TP
\fBdirectory=[path]\fR
Path to the directory in which to store backups.
.TP
\fBdirectory_tree=[0|1]\fR
When turned on (which is the default) and the client is on version 1.3.6 or greater, the structure of the storage directory will mimic that of the original filesystem on the client.
.TP
\fBtimestamp_format=[strftime format]\fR
This allows you to tweak the format of the timestamps of individual backups. See 'man strftime' to see available substitutions. If this option is unset, burp uses "%Y-%m-%d %H:%M:%S".
.TP
\fBpassword_check=[0|1]\fR
Allows you to turn client password checking on or off. The default is on. SSL certificates will still be checked if you turn passwords off. This option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBclientconfdir=[path]\fR
Path to the directory that contains client configuration files.
.TP
\fBprotocol=[0|1|2]\fR
Choose which style of backups and restores to use. 0 (the default) automatically decides based on the client version and which protocol is set on the client side. 1 forces protocol1 style (file level granularity with a pseudo mirrored storage on the server and optional rsync). 2 forces protocol2 style (inline deduplication with variable length blocks). If you choose a forced setting, it will be an error if the client also chooses a forced setting. This option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBlockfile=[path]\fR
Path to the lockfile that ensures that two server processes cannot run
simultaneously.
.TP
\fBpidfile=[path]\fR
Synonym for lockfile.
.TP
\fBsyslog=[0|1]\fR
Log to syslog. Defaults to off.
.TP
\fBstdout=[0|1]\fR
Log to stdout. Defaults to on.
.TP
\fBkeep=[number]\fR
Number of backups to keep. This can be overridden by the clientconfdir configuration files in clientconfdir on the server. Specify multiple 'keep' entries on separate lines in order to keep multiple periods of backups. For example, assuming that you are doing a backup a day, keep=7 keep=4 keep=6 (on separate lines) will keep 7 daily backups, 4 weekly backups (7x4=28), and 6 multiples of 4 weeks (7x4x6=168) \- roughly 6 monthly backups. Effectively, you will be guaranteed to be able to restore up to 168 days ago, with the number of available backups exponentially decreasing as you go back in time to that point. In this example, every 7th backup will be hardlinked to allow burp to safely delete intermediate backups when necessary. You can have as many 'keep' lines as you like, as long as they don't exceed 52560000 when multiplied together. That is, a backup every minute for 100 years.
.TP
\fBmanual_delete=[path]\fR
This can be overridden by the clientconfdir configuration files in clientconfdir on the server. When the server needs to delete old backups, or rubble left over from generating reverse patches with librsync=1, it will normally delete them in place. If you use the 'manual_delete' option, the files will be moved to the path specified for deletion at a later point. You will then need to configure a cron job, or similar, to delete the files yourself. Do not specify a path that is not on the same filesystem as the client storage directory.
.TP
\fBhardlinked_archive=[0|1]\fR
On the server, defines whether to keep hardlinked files in the backups, or whether to generate reverse deltas and delete the original files. Can be set to either 0 (off) or 1 (on). Disadvantage: More disk space will be used Advantage: Restores will be faster, and since no reverse deltas need to be generated, the time and effort the server needs at the end of a backup is reduced.
.TP
\fBmax_hardlinks=[number]\fR
On the server, the number of times that a single file can be hardlinked. The bedup program also obeys this setting. The default is 10000.
.TP
\fBlibrsync=[0|1]\fR
When set to 0, delta differencing will not take place. That is, when a file changes, the server will request the whole new file. The default is 1. This option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBcompression=zlib[0-9] (or gzip[0-9])\fR
Choose the level of zlib compression for files stored in backups. Setting 0 or zlib0 turns compression off. The default is zlib9. This option can be overridden by the client configuration files in clientconfdir on the server. 'gzip' is a synonym of 'zlib'.
.TP
\fBhard_quota=[b/Kb/Mb/Gb]\fR
Do not back up the client if the estimated size of all files is greater than the specified size. Example: 'hard_quota = 100Gb'. Set to 0 (the default) to have no limit.
.TP
\fBsoft_quota=[b/Kb/Mb/Gb]\fR
A warning will be issued when the estimated size of all files is greater than the specified size and smaller than hard_quota. Example: 'soft_quota = 95Gb'. Set to 0 (the default) to have no warning.
.TP
\fBversion_warn=[0|1]\fR
When this is on, which is the default, a warning will be issued when the client version does not match the server version. This option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBpath_length_warn=[0|1]\fR
When this is on, which is the default, a warning will be issued when the client sends a path that is too long to replicate in the storage area tree structure. The file will still be saved in a numbered file outside of the tree structure, regardless of the setting of this option. This option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBclient_lockdir=[path]\fR
Path to the directory in which to keep per-client lock files. By default, this is set to the path given by the 'directory' option.
.TP
\fBuser=[username]\fR
Run as a particular user. This can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBgroup=[groupname]\fR
Run as a particular group. This can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBumask=[umask]\fR
Set the file creation umask. Default is 0022.
.TP
\fBratelimit=[Mb/s]\fR
Set the network send rate limit, in Mb/s. If this option is not given, burp will send data as fast as it can.
.TP
\fBnetwork_timeout=[s]\fR
Set the network timeout in seconds. If no data is sent or received over a period of this length, burp will give up. The default is 7200 seconds (2 hours).
.TP
\fBworking_dir_recovery_method=[resume|delete]\fR
This option tells the server what to do when it finds the working directory of an interrupted backup (perhaps somebody pulled the plug on the server, or something). This can be overridden by the client configurations files in clientconfdir
on the server. Options are...
.TP
\fBdelete:\fR Just delete the old working directory.
.TP
\fBresume:\fR Continue the previous backup from the point at which it left off. NOTE: If the client has changed its include/exclude configuration since the backup was interrupted, the recovery method will automatically switch to 'delete'.
.TP
\fBclient_can_delete=[0|1]\fR
Turn this off to prevent clients from deleting backups with the '\-a delete' option. The default is that clients can delete backups. Restore clients can override this setting.
.TP
\fBclient_can_diff=[0|1]\fR
Turn this off to prevent clients from diffing backups with the '\-a d' option. The default is that clients can diff backups. Restore clients can override this setting.
.TP
.TP
\fBclient_can_force_backup=[0|1]\fR
Turn this off to prevent clients from forcing backups with the '\-a b' option. Timed backups will still work. The default is that clients can force backups.
.TP
\fBclient_can_list=[0|1]\fR
Turn this off to prevent clients from listing backups with the '\-a l' option. The default is that clients can list backups. Restore clients can override this setting.
.TP
\fBclient_can_restore=[0|1]\fR
Turn this off to prevent clients from initiating restores with the '\-a r' option. The default is that clients can initiate restores. Restore clients can override this setting.
.TP
\fBclient_can_verify=[0|1]\fR
Turn this off to prevent clients from initiating a verify job with the '\-a v' option. The default is that clients can initiate a verify job. Restore clients can override this setting.
.TP
\fBrestore_client=[client]\fR
A client that is permitted to list, verify, restore, delete, and diff files belonging to any other client. You may specify multiple restore_clients. If this is too permissive, you may set a restore_client for individual original clients in the individual clientconfdir files. Note that restoring a backup from a Windows computer onto a Linux computer will currently leave the VSS headers in place at the beginning of each file. This will be addressed in a future version of burp.
.TP
\fBssl_cert_ca=[path]\fR
The path to the SSL CA certificate. This file will probably be the same on both the server and the client. The file should contain just the certificate in PEM format. For more information on this, and the other ssl_* options, please see docs/burp_ca.txt.
.TP
\fBssl_cert=[path]\fR
The path to the server SSL certificate. It works for me when the file contains the concatenation of the certificate and private key in PEM format.
.TP
\fBssl_key=[path]\fR
The path to the server SSL private key in PEM format.
.TP
\fBssl_key_password=[password]\fR
Only needed for loading an encrypted certificate.
.TP
\fBssl_cert_password=[password]\fR
Synonym for ssl_key_password.
.TP
\fBssl_ciphers=[cipher list]\fR
Allowed SSL ciphers. See openssl ciphers for details.
.TP
\fBssl_compression=zlib[0|5] (or gzip[0|5])\fR
Choose the level of zlib compression over SSL. Setting 0 or zlib0 turns SSL compression off. Setting non-zero gives zlib5 compression (it is not currently possible for openssl to set any other level). The default is 5. 'gzip' is a synonym of 'zlib'.
.TP
.TP
\fBssl_dhfile=[path]\fR
Path to Diffie-Hellman parameter file. To generate one with openssl, use a command like this: openssl dhparam \-dsaparam \-out dhfile.pem 2048
.TP
\fBmax_children=[number]\fR
Defines the number of child processes to fork (the number of clients that can simultaneously connect. The default is 5.
.TP
\fBmax_status_children=[number]\fR
Defines the number of status child processes to fork (the number of status clients that can simultaneously connect. The default is 5.
.TP
\fBmax_storage_subdirs=[number]\fR
Defines the number of subdirectories in the data storage areas. The maximum number of subdirectories that ext3 allows is 32000. If you do not set this option, it defaults to 30000.
.TP
\fBtimer_script=[path]\fR
Path to the script to run when a client connects with the timed backup option. If the script exits with code 0, a backup will run. The first three arguments are the client name, the path to the 'current' storage directory, and the path to the top level storage directories. The next two arguments are reserved, and user arguments are appended after that. An example timer script is provided. The timer_script option can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBtimer_arg=[string]\fR
A user-definable argument to the timer script. You can have many of these. The timer_arg options can be overridden by the client configuration files in clientconfdir on the server.
.TP
\fBnotify_success_script=[path]\fR
Path to the script to run when a backup succeeds. User arguments are appended after the first five reserved arguments. An example notify script is provided. The notify_success_script option can be overriddden by the client configuration files in clientconfdir on the server.
.TP
\fBnotify_success_arg=[string]\fR
A user-definable argument to the notify success script. You can have many of these. The notify_success_arg options can be overriddden by the client configuration files in clientconfdir on the server.
.TP
\fBnotify_success_warnings_only=[0|1]\fR
Set to 1 to send success notifications when there were warnings. If this and notify_success_changes_only are not turned on, success notifications are always sent.
.TP
\fBnotify_success_changes_only=[0|1]\fR
Set to 1 to send success notifications when there were new or changed files. If this and notify_success_warnings_only are not turned on, success notifications are always sent.
.TP
\fBnotify_failure_script=[path]\fR
The same as notify_success_script, but for backups that failed.
.TP
\fBnotify_failure_arg=[string]\fR
The same as notify_success_arg, but for backups that failed.
.TP
\fBdedup_group=[string]\fR
Enables you to group clients together for file deduplication purposes. For example, you might want to set 'dedup_group=xp' for each Windows XP client, and then run the bedup program on a cron job every other day with the option '\-g xp'.
.TP
\fBserver_script_pre=[path]\fR
Path to a script to run on the server after each successfully authenticated connection but before any work is carried out. The arguments to it are 'pre', '(client command)', '(client name)', '(0 or 1 for success or failure)', '(timer script exit code)', and then arguments defined by server_script_pre_arg. If the script returns non-zero, the task asked for by the client will not be run. This command and related options can be overriddden by the client configuration files in clientconfdir on the server.
.TP
\fBserver_script_pre_arg=[string]\fR
A user-definable argument to the server pre script. You can have many of these.
.TP
\fBserver_script_pre_notify=[0|1]\fR
Turn on to send a notification email when the server pre script returns non-zero. The output of the script will be included in the email. The default is off. Most people will not want this turned on because clients usually contact the server at 20 minute intervals and this could cause a lot of emails to be generated. Requires the notify_failure options to be set.
.TP
\fBserver_script_post=[path]\fR
Path to a script to run on the server before the client disconnects. The arguments to it are 'post', '(client command)', '(client name), '(0 or 1 for success or failure)', '(timer script exit code)', and then arguments defined by server_script_post_arg. This command and related options can be overriddden by the client configuration files in clientconfdir on the server.
.TP
\fBserver_script_post_arg=[string]\fR
A user-definable argument to the server post script. You can have many of these.
.TP
\fBserver_script_post_notify=[0|1]\fR
Turn on to send a notification email when the server post script returns non-zero. The output of the script will be included in the email. The default is off. Requires the notify_failure options to be set.
.TP
\fBserver_script=[path]\fR
You can use this to save space in your config file when you want to run the same server script twice. It overrides server_script_pre and server_script_post. This command and related options can be overriddden by the client configuration files in clientconfdir on the server.
.TP
\fBserver_script_arg=[path]\fR
Goes with server_script and overrides server_script_pre_arg and server_script_post_arg.
.TP
\fBserver_script_notify=[0|1]\fR
Turn on to send notifications email when the server pre and post scripts return non-zero. The output of the script will be included in the email. The default is off. Requires the notify_failure options to be set.
.TP
\fBserver_script_post_run_on_fail=[0|1]\fR
If this is set to 1, server_script_post will always be run. The default is 0, which means that if the task asked for by the client fails, server_script_post will not be run.
.TP
\fBautoupgrade_dir=[path]\fR
Path to autoupgrade directory from which upgrades are downloaded. The option can be left unset in order not to autoupgrade clients. Please see docs/autoupgrade.txt in the source package for more help with this option.
.TP
\fBca_conf=[path]\fR
Path to certificate authority configuration file. The CA configuration file will usually be /etc/burp/CA.cnf. The CA directory indicated by CA.cnf will usually be /etc/burp/CA. If ca_conf is set and the CA directory does not exist, the server will create, populate it, and the paths indicated by ssl_cert_ca, ssl_cert, ssl_key and ssl_dhfile will be overwritten. For more detailed information on this and the other ca_* options, please see docs/burp_ca.txt.
.TP
\fBca_name=[name]\fR
Name of the CA that the server will generate when using the ca_conf option.
.TP
\fBca_server_name=[name]\fR
The name that the server will put into its own SSL certficates when using the ca_conf option.
.TP
\fBca_burp_ca=[path]\fR
Path to the burp_ca script when using the ca_conf option.
.TP
\fBca_crl=[path]\fR
Override the default path to the certificate revocation list.
.TP
\fBca_crl_check=[0|1]\fR
Whether to check for revoked certificates in the certificate revocation list.
.TP
\fBmonitor_browse_cache=[0|1]\fR
Whether or not the server should cache the directory tree when a monitor client is browsing. Advantage: browsing is faster. Disadvantage: more memory is used.
.TP
\fBlabel=[string]\fR
You can have multiple labels, and they can be overridden in the client configuration files in clientconfdir on the server. They will appear as an array of strings in the server status monitor JSON output. The idea is to provide a mechanism for arbirtrary values to be passed to clients of the server status monitor.
.TP
\fBenabled=[0|1]\fR
Set this to 0 if you want to disable all clients. The default is 1. This option can be overridden per-client in the client configuration files in clientconfdir on the server.

.SH CLIENT CONFIGURATION FILE OPTIONS

.TP
\fB. [glob]\fR
Read additional configuration files. On Windows, the glob is unimplemented - you will need to specify an actual file.
.TP
\fBmode=client\fR
Required to run in client mode.
.TP
\fBserver=[IP address or hostname]\fR
Defines the server to connect to.
.TP
\fBport=[port number]\fR
Defines the TCP port that the server is listening on.
.TP
\fBcname=[password]\fR
Defines the client name to identify as to the server.
.TP
\fBcname_lowercase=[0|1]\fR
Whether to force lowercase cname when detecting cname automatically (ie. no cname provided above). The default is 0. When set to 1 the name returned by the get_fqdn function will be lowercased.
.TP
\fBcname_fqdn=[0|1]\fR
Whether to keep fqdn cname (like 'testclient.example.com') when detecting cname automatically (ie. no cname provided above). The default is 1. When set to 0, the fqdn returned by the get_fqdn function will be stripped ('testclient.example.com' becomes 'testclient').
.TP
\fBprotocol=[0|1|2]\fR
Choose which style of backups and restores to use. 0 (the default) automatically decides based on the server version and which protocol is set on the server side. 1 forces protocol1 style (file level granularity with a pseudo mirrored storage on the server and optional rsync). 2 forces protocol2 style (inline deduplication with variable length blocks). If you choose a forced setting, it will be an error if the server also chooses a forced setting.
.TP
\fBpassword=[password]\fR
Defines the password to send to the server.
.TP
\fBenabled=[0|1]\fR
Set this to 0 if you want to disable a client. The default is 1. This option can also be set in the client configuration files in clientconfdir on the server.
.TP
\fBlockfile=[path]\fR
Path to the lockfile that ensures that two client processes cannot run
simultaneously (this currently doesn't work on Windows).
.TP
\fBpidfile=[path]\fR
Synonym for lockfile.
.TP
\fBsyslog=[0|1]\fR
Log to syslog. Defaults to off.
.TP
\fBstdout=[0|1]\fR
Log to stdout. Defaults to on.
.TP
\fBprogress_counter=[0|1]\fR
Print progress counters on stdout. Defaults to on.
.TP
\fBrandomise=[max secs]\fR
When running a timed backup, sleep for a random number of seconds (between 0 and the number given) before contacting the server. Alternatively, this can be specified by the '-q' command line option.
.TP
\fBuser=[username]\fR
Run as a particular user (not supported on Windows).
.TP
\fBgroup=[groupname]\fR
Run as a particular group (not supported on Windows).
.TP
\fBratelimit=[Mb/s]\fR
Set the network send rate limit, in Mb/s. If this option is not given, burp will send data as fast as it can.
.TP
\fBnetwork_timeout=[s]\fR
Set the network timeout in seconds. If no data is sent or received over a period of this length, burp will give up. The default is 7200 seconds (2 hours).
.TP
\fBca_burp_ca=[path]\fR
Path to the burp_ca script (burp_ca.bat on Windows). For more information on this, please see docs/burp_ca.txt.
.TP
\fBca_csr_dir=[path]\fR
Directory where certificate signing requests are generated. For more information on this, please see docs/burp_ca.txt.
.TP
\fBssl_cert_ca=[path]\fR
The path to the SSL CA certificate. This file will probably be the same on both the server and the client. The file should contain just the certificate in PEM format. For more information on this and the other ssl_* options, please see docs/burp_ca.txt.
.TP
\fBssl_cert=[path]\fR
The path to the client SSL certificate. It works for me when the file contains the concatenation of the certificate and private key in PEM format.
.TP
\fBssl_key=[path]\fR
The path to the client SSL private key in PEM format.
.TP
\fBssl_key_password=[password]\fR
Only needed for loading an encrypted certificate.
.TP
\fBssl_cert_password=[password]\fR
Synonym for ssl_key_password.
.TP
\fBssl_peer_cn=[string]\fR
Must match the common name in the SSL certificate that the server gives when it connects. If ssl_peer_cn is not set, the server name will be used instead.
.TP
\fBssl_ciphers=[cipher list]\fR
Allowed SSL ciphers. See openssl ciphers for details.
.TP
\fBserver_can_restore=[0|1]\fR
To prevent the server from initiating restores, set this to 0. The default is 1.
.TP
\fBserver_can_override_includes=[0|1]\fR
To prevent the server from being able to override your local include/exclude list, set this to 0. The default is 1.
.TP
\fBencryption_password=[password]\fR
Set this to enable client side file Blowfish encryption. If you do not want encryption, leave this field out of your config file. \fBIMPORTANT:\fR Configuring this renders delta differencing pointless, since the smallest real change to a file will make the whole file look different. Therefore, activating this option turns off delta differencing so that whenever a client file changes, the whole new file will be uploaded on the next backup. \fBALSO IMPORTANT:\fR If you manage to lose your encryption password, you will not be able to unencrypt your files. You should therefore think about having a copy of the encryption password somewhere off-box, in case of your client hard disk failing. \fBFINALLY:\fR If you change your encryption password, you will end up with a mixture of files on the server with different encryption and it may become tricky to restore more than one file at a time. For this reason, if you change your encryption password, you may want to start a fresh chain of backups (by moving the original set aside, for example). Burp will cope fine with turning the same encryption password on and off between backups, and will restore a backup of mixed encrypted and unencrypted files without a problem.
.TP
\fBglob_after_script_pre=[0|1]\fR
Set this to 0 if you do not want include_glob settings to be evaluated after the pre script is run. The default is 1.
.TP
\fBbackup_script_pre=[path]\fR
Path to a script to run before a backup. The arguments to it are 'pre', 'reserved2' to 'reserved5', and then arguments defined by backup_script_pre_arg - unless the option 'backup_script_reserved_args' is off, then only arguments defined by backup_script_pre_arg are passed to it.
.TP
\fBbackup_script_pre_arg=[string]\fR
A user-definable argument to the backup pre script. You can have many of these.
.TP
\fBbackup_script_post=[path]\fR
Path to a script to run after a backup. The arguments to it are 'post', [0|1] if the backup failed or succeeded, 'reserved3' to 'reserved5', and then arguments defined by backup_script_post_arg - unless the option 'backup_script_reserved_args' is off, then only arguments defined by backup_script_post_arg are passed to it.
.TP
\fBbackup_script_post_arg=[string]\fR
A user-definable argument to the backup post script. You can have many of these.
.TP
\fBbackup_script_post_run_on_fail=[0|1]\fR
If this is set to 1, backup_script_post will be run whether the backup succeeds or not. The default is 0, which means that backup_script_post will only be run if the backup succeeds.
.TP
\fBrestore_script_pre=[path]\fR
Path to a script to run before a restore. The arguments to it are 'pre', 'reserved2' to 'reserved5', and then arguments defined by restore_script_pre_arg - unless the option 'restore_script_reserved_args' is off, then only arguments defined by restore_script_pre_arg are passed to it.
.TP
\fBrestore_script_pre_arg=[string]\fR
A user-definable argument to the restore pre script. You can have many of these.
.TP
\fBrestore_script_post=[path]\fR
Path to a script to run after a restore. The arguments to it are 'post', [0|1] if the restore failed or succeeded, 'reserved3' to 'reserved5', and then arguments defined by restore_script_post_arg - unless the option 'restore_script_reserved_args' is off, then only arguments defined by restore_script_post_arg are passed to it.
.TP
\fBrestore_script_post_arg=[string]\fR
A user-definable argument to the restore post script. You can have many of these.
.TP
\fBrestore_script_post_run_on_fail=[0|1]\fR
If this is set to 1, restore_script_post will be run whether the restore succeeds or not. The default is 0, which means that restore_script_post will only be run if the restore succeeds.
.TP
\fBbackup_script=[path]\fR
You can use this to save space in your config file when you want to run the same script before and after a backup. It overrides backup_script_pre and backup_script_post.
.TP
\fBbackup_script_arg=[path]\fR
Goes with backup_script and overrides backup_script_pre_arg and backup_script_post_arg.
.TP
\fBbackup_script_reserved_args=[0|1]\fR
Whether to pass reserved arguments to backup scripts. The default is on.
.TP
\fBrestore_script=[path]\fR
You can use this to save space in your config file when you want to run the same script before and after a restore. It overrides restore_script_pre and restore_script_post.
.TP
\fBrestore_script_arg=[path]\fR
Goes with restore_script and overrides restore_script_pre_arg and restore_script_post_arg.
.TP
\fBrestore_script_reserved_args=[0|1]\fR
Whether to pass reserved arguments to restore scripts. The default is on.
.TP
\fBautoupgrade_dir=[path]\fR
Path to autoupgrade directory into which upgrades are downloaded. Please see docs/autoupgrade.txt in the source package for more help with this option. If you do not want your client to autoupgrade, do not set this option.
.TP
\fBautoupgrade_os=[string]\fR
Name of the client operating system. Should match a directory name in the server's autoupgrade_dir. If you do not want your client to autoupgrade, do not set this option.

.SH INCLUDES / EXCLUDES

.TP
The following options specify exactly what is backed up. The client can specify these options, or if you include at least one 'include=' in the client configuration files on the server, the server will override them all.
.TP
\fBinclude=[path]\fR
Path to include in the backup. You can have multiple include lines. Use forward slashes '/', not backslashes '\\' as path delimiters.
.TP
\fBexclude=[path]\fR
Path to exclude from the backup. You can have multiple exclude lines. Use forward slashes '/', not backslashes '\\' as path delimiters.
.TP
\fBinclude_glob=[glob expression]\fR
Include paths that match the glob expression. For example, '/home/*/Documents' will include '/home/user1/Documents' and '/home/user2/Documents' if directories 'user1' and 'user2' exist in '/home'. The Windows implementation currently limit the expression to contain only one '*'.
.TP
\fBinclude_regex=[regular expression]\fR
Not implemented.
.TP
\fBexclude_regex=[regular expression]\fR
Exclude paths that match the regular expression.
.TP
\fBinclude_ext=[extension]\fR
Extensions to include in the backup. Case insensitive. Nothing else will be included in the backup. You can have multiple include extension lines. For example, set 'txt' to include files that end in '.txt'. You need to specify an 'include' line so that burp knows where to start looking.
.TP
\fBexclude_ext=[extension]\fR
Extensions to exclude from the backup. Case insensitive. You can have multiple exclude extension lines. For example, set 'vdi' to exclude VirtualBox disk images.
.TP
\fBexclude_comp=[extension]\fR
Extensions to exclude from compression. Case insensitive. You can have multiple exclude compression lines. For example, set 'gz' to exclude gzipped files from compression.
.TP
\fBexclude_fs=[fstype]\fR
File systems to exclude from the backup. Case insensitive. You can have multiple exclude file system lines. For example, set 'tmpfs' to exclude tmpfs. Burp has an internal mapping of file system names to file system IDs. If you know the file system ID, you can use that instead. For example, 'exclude_fs = 0x01021994' will also exclude tmpfs.
.TP
\fBmin_file_size=[b/Kb/Mb/Gb]\fR
Do not back up files that are less than the specified size. Example: 'min_file_size = 10Mb'. Set to 0 (the default) to have no limit.
.TP
\fBmax_file_size=[b/Kb/Mb/Gb]\fR
Do not back up files that are greater than the specified size. Example: 'max_file_size = 10Mb'. Set to 0 (the default) to have no limit.
.TP
\fBcross_filesystem=[path]\fR
Allow backups to cross a particular filesystem mountpoint.
.TP
\fBcross_all_filesystems=[0|1]\fR
Allow backups to cross all filesystem mountpoints.
.TP
\fBnobackup=[file name]\fR
If this file system entry exists, the directory containing it will not be backed up.
.TP
\fBread_fifo=[path]\fR
Do not back up the given fifo itself, but open it for reading and back up the contents as if it were a regular file.
.TP
\fBread_all_fifos=[0|1]\fR
Open all fifos for reading and back up the contents as if they were regular files.
.TP
\fBread_blockdev=[path]\fR
Do not back up the given block device itself, but open it for reading and back up the contents as if it were a regular file.
.TP
\fBread_all_blockdevs=[0|1]\fR
Open all block devices for reading and back up the contents as if they were regular files.
.TP
\fBsplit_vss=[0|1]\fR
When backing up Windows computers with burp protocol 1, this option allows you to save the VSS header data separate from the file data. The default is off, which means that the VSS header data is saved prepended to the file data.
.TP
\fBstrip_vss=[0|1]\fR
When backing up Windows computers with burp protocol 1, this option allows you to prevent the VSS header data being backed up. The default is off. To restore a backup that has no VSS information on Windows, you need to give the client the '\-x' command line option.
.TP
\fBvss_drives=[list of drive letters]\fR
When backing up Windows computers, this option allows you to specify which drives have VSS snapshots taken of them. If you omit this option, burp will automatically decide based on the 'include' options. If you want no drives to have snapshots taken of them, you can specify '0'.
.TP
\fBacl=[0|1]\fR
If acl support is compiled into burp, this allows you to decide whether or not to backup acls at runtime. The default is '1'.
.TP
\fBxattr=[0|1]\fR
If xattr support is compiled into burp, this allows you to decide whether or not to backup xattrs at runtime. The default is '1'.
.TP
\fBatime=[0|1]\fR
This allows you to control whether the client uses O_NOATIME when opening files and directories. The default is 0, which enables O_NOATIME. This means that the client can read files and directories without updating the access times. However, this is only possible if you are running as root, or are the owner of the file or directory. If this is not the case (perhaps you only have group or world access to the files), you will get errors until you set atime=1. With atime=1, the access times will be updated on the files and directories that get backed up.
.TP
\fBscan_problem_raises_error=[0|1]\fR
When enabled, this causes problems in the phase1 scan (such as an 'include' being missing) to be treated as fatal errors. The default is off.

.SH SERVER CLIENTCONFDIR FILE
.TP
For the server to know about clients that can contact it, you need to place a file named after the client in clientconfdir. Files beginning with '.' or ending with '~' are ignored. Directories are also ignored.
.TP
The file name must match the name in the 'cname' field on the client.
.TP
\fBssl_peer_cn=[string]\fR must match the common name in the SSL certificate that the client gives when it connects. If ssl_peer_cn is not set, the client name will be used instead (the clientconfdir file name).
.TP
The file needs to contain a line like \fBpassword=[password]\fR that matches the same field on the client, or \fBpasswd=[hash]\fR \- where the plain text password on the client will be tested against a hash of the kind you might find in /etc/passwd.
.TP
Additionally, the following options can be overridden here for each client:
\fBenabled\fR
\fBprotocol\fR
\fBdirectory\fR
\fBdirectory_tree\fR
\fBtimestamp_format\fR
\fBpassword_check\fR
\fBkeep\fR
\fBmanual_delete\fR
\fBworking_dir_recovery_method\fR
\fBlibrsync\fR
\fBversion_warn\fR
\fBpath_length_warn\fR
\fBsyslog\fR
\fBclient_can_delete\fR
\fBclient_can_force_backup\fR
\fBclient_can_list\fR
\fBclient_can_restore\fR
\fBclient_can_verify\fR
\fBrestore_client\fR
\fBcompression\fR
\fBhard_quota\fR
\fBsoft_quota\fR
\fBlabel\fR
\fBtimer_script\fR
\fBtimer_arg\fR
\fBnotify_success_script\fR
\fBnotify_success_arg\fR
\fBnotify_success_warnings_only\fR
\fBnotify_failure_script\fR
\fBnotify_failure_arg\fR
\fBdedup_group\fR
\fBserver_script_pre\fR
\fBserver_script_pre_arg\fR
\fBserver_script_pre_notify\fR
\fBserver_script_post\fR
\fBserver_script_post_arg\fR
\fBserver_script_post_notify\fR
\fBserver_script\fR
\fBserver_script_arg\fR
\fBserver_script_notify\fR
\fBserver_script_post_run_on_fail\fR
.TP
Additionally, the includes and excludes can be overridden here, as described in the section above.
.TP
As with the other configuration files, extra configuration can be included with the '. path/to/config/file' syntax.

.SH Some notes on SSL certificates
.TP
The burp example configs come with example SSL certificates and keys. You can use these and burp will work. But if you are worried about network security, you should generate your own certificates and keys and point your config files to them. To create the example files, I used a handy interface to openssl, called 'tinyca' (http://tinyca.sm-zone.net/). If you are using Debian, you can run 'apt-get install tinyca' to get it. There is also the option of using burp_ca, which you can find in the source distribution, courtesy of Patrick Koppen.

.SH Examining backups
.TP
As well as using the client list options described above, you can go directly to the storage directory on the server. The backups for a client are in the directory named after the client. Inside each backup directory is a file called manifest.gz.
.TP
This contains a list of all the files in the backup, and where they originally came from on the client.
.TP
There is also a 'log.gz' file in the backup directory, which contains the output generated by the server during the backup.
.TP
The 'data' directory contains complete backup files.
.TP
The 'deltas.reverse' directory contains reverse deltas that can be applied to the data from the next backup in the sequence (indicated by the contents of the 'forward' file).
.TP
Anything with a .gz suffix is compressed in zlib (gzip) format.  You can use standard tools, such as zcat, zless or cp, to view them or copy them elsewhere. Files from Windows backups will probably contain VSS headers and/or footers. For help stripping these, see the vss_strip man page.

.SH Server initiated backups
.TP
You can queue a backup on the server, to be performed when the client next makes contact. To do this, you put a file called 'backup' into the top level of the client storage directory. The contents of the file are ignored.

.SH Server initiated restores
.TP
You can queue a restore on the server, to be performed when the client next makes contact. To do this, you put a file called 'restore' into the top level of the client storage directory. The client can deny server initiated restores by setting "server_can_restore=0" in its burp.conf. Valid fields to include in the restore file are:
.TP
\fBorig_client=[client]\fR
The original client to restore from. Equivalent to '\-C' when initiating a restore from a client. Do not include this line when restoring to the original client. See also the 'restore_client' server option.
.TP
\fBbackup=[number|a]\fR
The number of the backup to restore from. Equivalent to '\-b' when initiating a restore from the client.
.TP
\fBoverwrite=[0|1]\fR
Whether to overwrite existing files. Equivalent to '\-f' when initiating a restore from the client.
.TP
\fBstrip=[number]\fR
Number of leading path components to strip. Equivalent to '\-s' when initiating a restore from the client.
.TP
\fBrestoreprefix=[path]\fR
Prefix to the restore path. Equivalent to '\-d' when initiating a restore from the client.
.TP
\fBstripfrompath=[string]\fR
Strip matching string from restore paths (before prefix is prepended).
.TP
\fBregex=[regular expression]\fR
Only restore files matching the regular expression. Equivalent to '\-r' when initiating a restore from the client.
.TP
\fBinclude=[path]\fR
Restore directories and files that match the path. If it is a directory, the contents of the directory will be restored. You can have multiple 'include' lines. There is no equivalent when initiating a restore from the client.

.SH SIGNALS
Sending signal 1 (HUP) to the main server process will cause it to reload. For the vast majority of configuration changes, a reload is unnecessary as the server will pick up changes "on-the-fly". Sending signal 12 (USR2) to the main server process will cause it to wait until there are no longer any child processes, and then exit. The intention is to help with upgrades without interrupting current backups. if you are running upstart, a new burp server process will start up when the old one exits.

.SH RETURN CODES (SERVER)
0: success
.br
1: error

.SH RETURN CODES (CLIENT)
0: success
.br
1: error
.br
2: restore gave warnings
.br
3: timer conditions on the server were not met
.br
4: could not connect to server

.SH BUGS
If you find bugs, please report them to the email list. See the website
<http://burp.grke.net/> for details.

.SH AUTHOR
The main author of Burp is Graham Keeling.

.SH COPYRIGHT
See the LICENCE file included with the source distribution.
